Skip to main content

Webhook: COMMENT_CREATED

Обзор​

Webhook COMMENT_CREATED срабатывает, когда добавляется новый комментарий к инциденту или задаче. Он уведомляет систему или пользователей о создании комментария, что помогает отслеживать обновления, обсуждения или изменения, связанные с соответствующими задачами или инцидентами.

Цель​

Webhook гарантирует, что заинтересованные стороны или системы своевременно информируются, когда добавляется новый комментарий, помогая поддерживать осведомлённость о текущих коммуникациях или обновлениях, связанных с задачами или инцидентами.

Формат запроса​

Webhook отправляет HTTP POST запрос с следующим JSON-пейлоадом:

{
   "entityId": "eb6c9de2-8969-4568-8fb1-cc4d99962ec1",
   "type": "COMMENT_CREATED",
   "createdAt": "2024-12-16T12:20:28.647Z",
   "data": {
      "operation": "INSERT",
      "current": {
         "id": "eb6c9de2-8969-4568-8fb1-cc4d99962ec1",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
         "relatedEntityId": "9af5d7b0-b1e2-4436-b02e-1c6346eb09d1",
         "relatedEntityType": "TASK",
         "message": "Новый комментарий!"
      },
      "previous": null
   },
   "id": 201
}

Ключевые свойства​

Верхний уровень​

  • entityId: Уникальный идентификатор комментария.
  • type: Указывает тип webhook (COMMENT_CREATED).
  • createdAt: Временная метка, когда webhook был создан, в формате ISO 8601.
  • data: Содержит подробную информацию о новом комментарии.

Поля данных​

Операция​

  • operation: Описание выполненного действия. Для новых комментариев это всегда INSERT.

Данные текущего (нового комментария)​

  • id: Уникальный идентификатор комментария.
  • organizationId: Идентификатор организации, связанной с комментариев.
  • createdBy: Идентификатор пользователя, создавшего комментарий.
  • relatedEntityId: Идентификатор связанной задачи или инцидента.
  • relatedEntityType: Указывает, является ли связанная сущность задачей (TASK) или инцидентом (ISSUE).
  • message: Текстовое содержание комментария.

Предыдущие​

  • previous: Данные комментария до текущей операции. Для новых комментариев это поле всегда равно null.

Пример ответа​

Пример пейлоада для успешного срабатывания webhook:

{
   "entityId": "eb6c9de2-8969-4568-8fb1-cc4d99962ec1",
   "type": "COMMENT_CREATED",
   "createdAt": "2024-12-16T12:20:28.647Z",
   "data": {
      "operation": "INSERT",
      "current": {
         "id": "eb6c9de2-8969-4568-8fb1-cc4d99962ec1",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
         "relatedEntityId": "9af5d7b0-b1e2-4436-b02e-1c6346eb09d1",
         "relatedEntityType": "TASK",
         "message": "Новый комментарий!"
      },
      "previous": null
   }
}

Преимущества​

  1. Сотрудничество в реальном времени: Обеспечивает своевременные уведомления для всех участников о новых комментариях, способствуя эффективному сотрудничеству.
  2. Улучшенное отслеживание: Позволяет системам и пользователям отслеживать обновления или обсуждения, связанные с задачами или инцидентами.
  3. Оптимизация коммуникации: Автоматизирует процесс уведомления заинтересованных сторон, уменьшая вероятность пропуска критически важных обновлений.

Webhook COMMENT_CREATED упрощает управление коммуникациями, обеспечивая своевременные обновления обо всех новых комментариях.